What is @aws-cdk/aws-route53?
@aws-cdk/aws-route53 is an AWS Cloud Development Kit (CDK) library that allows you to define and manage Amazon Route 53 resources using code. It provides a high-level, object-oriented abstraction to create and manage DNS zones, records, and other Route 53 features.
What are @aws-cdk/aws-route53's main functionalities?
Create a Hosted Zone
This code sample demonstrates how to create a new hosted zone in Route 53 using the AWS CDK. A hosted zone is a container for DNS records for a specific domain.
const route53 = require('@aws-cdk/aws-route53');
const cdk = require('@aws-cdk/core');
const app = new cdk.App();
const stack = new cdk.Stack(app, 'MyStack');
const zone = new route53.HostedZone(stack, 'MyHostedZone', {
zoneName: 'example.com',
});
app.synth();
Create an A Record
This code sample demonstrates how to create an A record in a hosted zone. An A record maps a domain name to an IPv4 address.
const route53 = require('@aws-cdk/aws-route53');
const cdk = require('@aws-cdk/core');
const app = new cdk.App();
const stack = new cdk.Stack(app, 'MyStack');
const zone = new route53.HostedZone(stack, 'MyHostedZone', {
zoneName: 'example.com',
});
new route53.ARecord(stack, 'MyARecord', {
zone,
target: route53.RecordTarget.fromIpAddresses('1.2.3.4'),
});
app.synth();
Create a CNAME Record
This code sample demonstrates how to create a CNAME record in a hosted zone. A CNAME record maps a domain name to another domain name.
const route53 = require('@aws-cdk/aws-route53');
const cdk = require('@aws-cdk/core');
const app = new cdk.App();
const stack = new cdk.Stack(app, 'MyStack');
const zone = new route53.HostedZone(stack, 'MyHostedZone', {
zoneName: 'example.com',
});
new route53.CnameRecord(stack, 'MyCnameRecord', {
zone,
domainName: 'example.com',
recordName: 'www',
});
app.synth();
Create an Alias Record
This code sample demonstrates how to create an alias record in a hosted zone. An alias record maps a domain name to an AWS resource, such as an Elastic Load Balancer.
const route53 = require('@aws-cdk/aws-route53');
const cdk = require('@aws-cdk/core');
const targets = require('@aws-cdk/aws-route53-targets');
const elbv2 = require('@aws-cdk/aws-elasticloadbalancingv2');
const app = new cdk.App();
const stack = new cdk.Stack(app, 'MyStack');
const zone = new route53.HostedZone(stack, 'MyHostedZone', {
zoneName: 'example.com',
});
const lb = new elbv2.ApplicationLoadBalancer(stack, 'LB', {
vpc,
internetFacing: true,
});
new route53.ARecord(stack, 'AliasRecord', {
zone,
target: route53.RecordTarget.fromAlias(new targets.LoadBalancerTarget(lb)),
});
app.synth();
Other packages similar to @aws-cdk/aws-route53
aws-sdk
The aws-sdk package is the official AWS SDK for JavaScript. It provides low-level access to all AWS services, including Route 53. Unlike @aws-cdk/aws-route53, which is a high-level abstraction for defining infrastructure as code, aws-sdk requires more detailed and manual configuration.
serverless
The serverless framework allows you to build and deploy serverless applications on AWS and other cloud providers. It includes plugins for managing Route 53 resources. While it provides a higher-level abstraction than aws-sdk, it is not as integrated with infrastructure as code as the AWS CDK.
terraform
Terraform is an open-source infrastructure as code software tool created by HashiCorp. It allows you to define and provision data center infrastructure using a high-level configuration language. Terraform has a provider for AWS, including Route 53 resources. It is similar to AWS CDK in that it allows you to define infrastructure as code, but it uses a different syntax and approach.
AWS Route53 Construct Library
To add a public hosted zone:
import route53 = require('@aws-cdk/aws-route53');
new route53.PublicHostedZone(this, 'HostedZone', {
zoneName: 'fully.qualified.domain.com'
});
To add a private hosted zone, use PrivateHostedZone
. Note that
enableDnsHostnames
and enableDnsSupport
must have been enabled for the
VPC you're configuring for private hosted zones.
import ec2 = require('@aws-cdk/aws-ec2');
import route53 = require('@aws-cdk/aws-route53');
const vpc = new ec2.VpcNetwork(this, 'VPC');
const zone = new route53.PrivateHostedZone(this, 'HostedZone', {
zoneName: 'fully.qualified.domain.com',
vpc
});
Additional VPCs can be added with zone.addVPC()
.
Adding Records
To add a TXT record to your zone:
import route53 = require('@aws-cdk/aws-route53');
new route53.TxtRecord(zone, 'TXTRecord', {
recordName: '_foo',
recordValue: 'Bar!',
ttl: 90,
});
Adding records to existing hosted zones
If you know the ID and Name of a Hosted Zone, you can import it directly:
const zone = HostedZone.import(this, 'MyZone', {
zoneName: 'example.com',
hostedZoneId: 'ZOJJZC49E0EPZ',
});
If you don't know the ID of a Hosted Zone, you can use the HostedZoneProvider
to discover and import it:
const zone = new HostedZoneProvider(this, {
domainName: 'example.com'
}).findAndImport(this, 'MyZone');